home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / datatypes / jfif_dtc / jfif.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  20KB  |  355 lines
  1. @database JFIF.guide
  2. @$VER: JFIF.guide 0.1 (17.9.94)
  3. @node main "JFIF DataType Documentation - Contents"
  4. ---------------------------------------------------------------------------
  5.             Tower JFIF DataTypes Class & Tower JPEG Codec Class
  6.                Copyright 
  7.  1994 Christoph Feck, TowerSystems
  8.                            All Rights Reserved.
  9.                                      -
  10.                 JFIF DataType Preferences (MUI Application)
  11.                      Copyright 
  12.  1994 Matthias Scheler
  13.                            All Rights Reserved.
  14.                 This software is based in part on the work
  15.                        of the Independent JPEG Group
  16. ---------------------------------------------------------------------------
  17.    @{" Introduction      " link Introduction}                  What is the JFIF datatype?
  18.    @{" Requirements      " link Requirements}                  What system do I need?
  19.    @{" Installation      " link Installation}                  Before using the datatype.
  20.    @{" Configuration     " link Configuration}                  The preferences editor.
  21.    @{" Tips & Hints      " link Tips}                  Some useful notes.
  22.    @{" Known Bugs        " link Bugs}                  What does not work?
  23.    @{" History           " link History}                  What is new in this version?
  24.    @{" Acknowledgments   " link Acknowledgments}                  Who I want to thank.
  25.    @{" Disclaimer        " link Disclaimer}                  Short: Use it at your own risk!
  26.    @{" Copyright         " link Copyright}                  About legal issues.
  27.    @{" License           " link License}                  What you have to agree on.
  28.    @{" Giftware          " link Giftware}                  A call for courage.
  29.    @{" Support           " link Support}                  About updates and support.
  30.    @{" Author            " link Author}                  Where you can reach me.
  31. @endnode
  32. @node Introduction "JFIF DataType Documentation - Introduction"
  33. Introduction
  34. ************
  35. Starting with OS Release 3 the Amiga has the concept of `datatypes', which
  36. allow reading and viewing files of different types and formats.  MultiView
  37. utilizes these datatypes and displays any file for which you have a data
  38. types class installed.  Already supplied on your Workbench disk is the ILBM
  39. datatype for loading regular IFF-ILBM pictures.
  40. Using this JFIF datatype you can enhance the functionality of MultiView and
  41. other datatypes-aware applications:  The Tower JFIF DataTypes Class allows
  42. you to read and view JFIF files.  JFIF is the de facto standard file format
  43. for JPEG compressed images.
  44. @endnode
  45. @node Requirements "JFIF DataType Documentation - Requirements"
  46. Requirements
  47. ************
  48. To use datatypes, you need Amiga OS Release 3.  Older versions will not be
  49. sufficient.
  50. You should have 2 megabytes main memory, as well as a harddisk to store
  51. temporary files.  It may or may not work on a floppy based system.
  52. A 68020 CPU is not required, but recommended; JPEG files need much time to
  53. decode.  The presence (or absence) of a math coprocessor does not affect
  54. decoding time.
  55. The installation script requires the Commodore Installer utility.  It is
  56. not included.
  57. One of the preferences editors needs MUI.  MUI is not included.  If you do
  58. not have MUI, you can still use the regular GadTools version.
  59. @endnode
  60. @node Installation "JFIF DataType Documentation - Installation"
  61. Installation
  62. ************
  63. Please use the supplied installation script to install all files.  Manual
  64. installation is disrecommended.
  65. The datatype uses the Tower JPEG Codec Class to decode (decompress) the
  66. JPEG data within the JFIF file.  This codec, including codec.class, picture
  67. codec and tower.library, must be correctly installed.  The installation
  68. script will do this for you.  If you already have the JPEG codec installed,
  69. be sure to not overwrite newer versions with older versions.
  70. @endnode
  71. @node Configuration "JFIF DataType Documentation - Configuration"
  72. Configuration
  73. *************
  74. The JFIF DataType Preferences Editor allows you to modify several options
  75. of the JFIF datatype.  The installer copies the editor to the Prefs drawer
  76. of your system partition.  When you start the editor, you will see a window
  77. with a listview on the left side, several cyclegadgets and checkbuttons on
  78. the right side, and the usual Save/Use/Cancel buttons on the bottom.
  79. The listview is used to select, edit, add, and remove the names of the
  80. applications, for which you want to control the settings.  The actual name
  81. of the application is the process/task name, or the command name for Shell
  82. processes.  The name will usually be the filename of the program you
  83. started.  You can enter AmigaDOS patterns as the name, the first matching
  84. entry decides which settings apply.
  85. Available Options
  86. -----------------
  87. The option gadgets on the right side of the window allow you to edit the
  88. settings.  Following settings can be changed:
  89. - "Rendermode" selects the basic type of output.  In conjunction with the
  90.   numeric gadget you can set the number of colors you want in the picture:
  91.   - For HAM mode, 16 colors will force HAM6, 64 colors will force HAM8
  92.     (even if you have no AGA chipset), and 0 means automatic selection.
  93.   - For colormapped and grayscale modes, the number of colors directly
  94.     affects the size of the colormap, and the bitmap's depth.  If you use
  95.     0 colors in those two modes, you will get the maximum number (256).
  96. - "Scaling" (1:1, 1:2, 1:4, or 1:8) controls the size of the picture.  It
  97.   will also drastically reduce memory requirements and decoding time.
  98. - "Dithermode" allows you to select the type of dithering.  Currently this
  99.   does not affect HAM modes.
  100. - "Single-Pass Quantization" instructs the datatype to use a fixed palette,
  101.   instead of choosing an optimized palette.  For now, HAM modes will always
  102.   use a static palette.
  103. - The "Slow ... Method" options enable slower, but higher quality modes.
  104. - "Find Best Display Mode" controls the selection of the screenmode the
  105.   picture will get.  If this button is not checked, a default mode is used.
  106. - The "Large Histogram" option affects the size of the histogram.  The
  107.   histogram is required to select an optimized color palette.  If enabled,
  108.   a full-sized histogram is computed.  This will notably increase quality,
  109.   but will also consume much more memory.  If the memory is not available,
  110.   a temporary file will be created on your harddisk.
  111. - The "Progress Indicator" is very useful for slower machines.  It will
  112.   show you a growing bar, so you can estimate the time required to finish.
  113.   Additionally, you can abort the operation by closing the small window.
  114.   This will not work, if the datatype is currently busy with choosing the
  115.   colormap.  The window will open on the same screen DOS requesters would
  116.   open on.
  117. MUI versus GadTools
  118. -------------------
  119. Depending on your selection during installation, you will either have a
  120. GadTools version, or a MagicUserInterface (MUI) version of the editor.
  121. Both are substantially the same; the remaining differences are:
  122. - The GadTools version will always display the default settings at the top
  123.   of the listview, but still uses them only when no matching application
  124.   is found.
  125. - In the MUI version, you can change the order of applications in the
  126.   listview using the Up/Down buttons.  This is useful to temporarily delete
  127.   the settings of a particular application by moving it below the `Default'
  128.   entry.  To add a default settings entry, enter an empty name (just press
  129.   Return).
  130. @endnode
  131. @node Tips "JFIF DataType Documentation - Tips & Hints"
  132. Tips & Hints
  133. ************
  134. If you only want to display a picture, the settings should match the actual
  135. capabilities of your display hardware.  For example, on an ECS Amiga it is
  136. not recommended to let the datatype return a 256 color bitmap.  The color
  137. reduction in the datatypes system does not work as good as the algorithms
  138. in the JFIF datatype.  You will gain both speed and quality, if you reduce
  139. the number of colors to the amount displayable by your system.
  140. This is also true for images viewed on a pen-sharing screen, such as the
  141. Workbench screen.  Even if you have a 256 color Workbench, not all colors
  142. can be used by datatypes.  You may end up getting nicer pictures by using
  143. e.g. 128 colors.  If you intend to view multiple images on one screen,
  144. reduce the amount of colors even more.  Otherwise you may be left with an
  145. unusable set of colors for the next picture.  This is in particular true
  146. for Multimedia applications, where many images must be displayed on a
  147. single screen.
  148. If your screen has no sharable pens (e.g. you have a 4 color screen), you
  149. should try the grayscale mode with up to 4 grayscales.  The dithering will
  150. be much nicer, compared to a 256 color or 256 grayscale image.
  151. It is highly disrecommended to use a JPEG image as a Workbench or window
  152. backdrop, or as a pattern for MUI.  The decoding will probably take too
  153. long.  Instead, use MultiView to save the image in IFF-ILBM format.  This
  154. format can be loaded much faster.  Be sure to reduce the number of colors,
  155. otherwise the backdrop may steal all free pens you have.  For permanent
  156. backdrop images on a 256 colors screen, 16 or 32 colors should be enough.
  157. Datatypes decode pictures into a standard bitmap in Chip memory.  If you
  158. are low on Chip memory, you should scale the picture.
  159. Most (but not all) JPEG files conform to the JFIF standard; only these can
  160. be read with the JFIF datatype.  Formats such as PICT/JPEG, TIFF/JPEG, or
  161. HSI are not supported, neither are `plain' (raw) JPEG files without a JFIF
  162. marker.
  163. @endnode
  164. @node Bugs "JFIF DataType Documentation - Known Bugs"
  165. Known Bugs
  166. **********
  167. @endnode
  168. @node History "JFIF DataType Documentation - History"
  169. History
  170. *******
  171. Release 1, on 12-Dec-94:
  172. - If SYS:Classes didn't exists, it created the directory, which is useless,
  173.   since LIBS: doesn't point to it.  It now writes to LIBS: directly.
  174. - Pretend mode failed, if you had not installed the ENV settings yet.
  175. - First public release.
  176. Gamma Release, released on 23-Nov-94:
  177. - Oops... tower.library/GetString was broken, causing a full hang whenever
  178.   a message needed to be displayed.
  179. - Various Installer script fixes, added reboot code.
  180. - Ignores path even for process/task names.
  181. Beta-2, released on 17-Nov-94:
  182. - Reduced stack usage in two pass quantization (shouldn't crash IPrefs
  183.   anymore).
  184. - Fixed a couple of bugs in tower.library.  One bug could cause the machine
  185.   to crash.
  186. - BestModeID now tries to use an interlaced mode for lores HAM.
  187. - Now ignores the path when matching command names.
  188. - Fixed keyboard shortcuts in MUI version.
  189. - Fixed a bug in the datatype, which prevented it from dithering 256 colors
  190.   down to an ECS screen.
  191. - Moved HAM conversion to picture.codec.
  192. - Fixed a bug in the prefs editor, which caused settings to be lost in some
  193.   cases.
  194. - The JPEG codec has been recompiled using the official V5 IJG code.
  195. - Now opens the progress window on the same screen DOS requesters open on.
  196. - Added documentation, Installer script, and cleaned up the distribution.
  197. Beta-1, released on 06-Sep-94:
  198. - Initial beta release.
  199. @endnode
  200. @node Acknowledgments "JFIF DataType Documentation - Acknowledgments"
  201. Acknowledgments
  202. ***************
  203. The following people deserve to get especially mentioned in this place:
  204. - The Independent JPEG Group.  I used their source to create the JPEG codec
  205.   class.  Even while the source is excellent, you should not use it on the
  206.   Amiga; use the JPEG codec instead.  For details, refer to the Copyright
  207.   section.
  208. - Matthias `Tron' Scheler.  He created the MUI version of the preferences
  209.   editor.  Originally, there was no preferences editor at all; I wrote the
  210.   GadTools version only after I saw how much memory MUI needs :)  Also, I
  211.   must thank him for allowing me to include it in this distribution.
  212. - All my beta testers for their suggestions and bug reports.
  213. - Osma Ahvenlampi and Mark Rose for creating MagicWB style icons for the
  214.   preferences editor.
  215. @endnode
  216. @node Disclaimer "JFIF DataType Documentation - Disclaimer"
  217. Disclaimer
  218. **********
  219. Standard disclaimer:
  220. THERE IS NO WARRANTY FOR THE SOFTWARE TO THE EXTENT PERMITTED BY APPLICABLE
  221. LAW.  EXCEPT WHERE OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
  222. OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
  223. EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  224. WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE
  225. ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU.
  226. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
  227. SERVICING, REPAIR OR CORRECTION.
  228. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
  229. ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE SOFTWARE
  230. AS PERMITTED BELOW, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL,
  231. SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
  232. INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR
  233. DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES
  234. OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF
  235. SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  236. DAMAGES.
  237. @endnode
  238. @node Copyright "JFIF DataType Documentation - Copyright"
  239. Copyright
  240. *********
  241. The Tower JFIF DataTypes Class and the Tower JPEG Codec Class are Copyright
  242.  1994 Christoph Feck, TowerSystems.  All Rights Reserved.
  243. The JFIF DataTypes Preferences Editor (MUI Application) is Copyright 
  244.  1994
  245. Matthias Scheler.  All Rights Reserved.  Inclusion in this distribution per
  246. agreement.
  247. This archive may only be distributed in unmodified form.  No files may be
  248. added, changed or removed.  You may not charge for this archive, other than
  249. the cost of the media and duplication fees, as long as they don't exceed
  250. the fees taken by Fred Fish.  Distribution is allowed in all forms, such as
  251. BB systems, floppy or compact disks, and ftp sites.
  252. Any inclusion in a commercial, semi-commercial or Shareware distribution
  253. requires the written permission of the author.
  254. About the JPEG codec class
  255. --------------------------
  256. The license described in the next section only applies to the JFIF datatype
  257. archive as a whole, including the JPEG codec and all other files.  For the
  258. Tower JPEG Codec Class (including needed super classes) a separate license
  259. may be obtained to distribute it together with your programs or software.
  260. This license is available for both freely distributable and commercial
  261. software.  To obtain the license, you must contact the author, and ask for
  262. a license to distribute the Tower JPEG Codec Class.
  263. The codec is a shared BOOPSI class library for reading and writing JPEG
  264. files.  A linkage library will not be available.  Programs using the class
  265. will automatically benefit from any future improvements made to the codec.
  266. Interfacing is very easy, existing applications can be modified to utilize
  267. the class using minimal work.  It is designed to process 24 bit data on a
  268. scanline base.  A developer kit, including C header files, example code,
  269. and documentation, can be obtained from the author.
  270. @endnode
  271. @node License "JFIF DataType Documentation - License"
  272. License
  273. *******
  274. These are the conditions you must agree on before and while using the JFIF
  275. datatypes class, the JPEG codec class, and all other included files:
  276. You may copy and distribute verbatim copies of the classes, programs, and
  277. documentation as you receive it, in any medium, provided that you
  278. conspicuously and appropriately publish only the original, unmodified files
  279. with all copyright notices and disclaimers of warranty intact and including
  280. all the accompanying documentation and anything else that came with the
  281. original archive.
  282. Except where otherwise stated in this documentation, you may not copy
  283. and/or distribute the classes and programs without the accompanying
  284. documentation and other additional files that came with the original.  You
  285. may not copy and/or distribute modified versions of the classes and
  286. programs.
  287. You may not copy, modify, sublicense, distribute or transfer the files
  288. except as expressly provided under this license.  Any attempt otherwise to
  289. copy, modify, sublicense, distribute or transfer the files is void, and
  290. will automatically terminate your rights to use the files under this
  291. license.  However, parties who have received copies, or rights to use
  292. copies, from you under this license will not have their licenses terminated
  293. so long as such parties remain in full compliance.
  294. By copying, distributing and/or using the files you indicate your
  295. acceptance of this license to do so, and all its terms and conditions.
  296. Each time you redistribute the files, the recipient automatically receives
  297. a license from the original licensor to copy, distribute and/or use the
  298. files subject to these terms and conditions.  You may not impose any
  299. further restrictions on the recipients' exercise of the rights granted
  300. herein.
  301. You may not disassemble, decompile, re-source or otherwise reverse-engineer
  302. the classes and programs.
  303. You agree to cease distributing the files if requested to do so by the
  304. authors.
  305. @endnode
  306. @node Giftware "JFIF DataType Documentation - Giftware"
  307. Giftware
  308. ********
  309. The creation and support of this and future software has taken (and will
  310. continue to take) a large amount of my time.
  311. I strongly encourage you to think a minute about the effort I put into this
  312. software and about the improvement it makes to your system or the joy you
  313. would miss, if I had not released it.  I am pretty sure you will conclude
  314. that my work is not worthless at all, but rather deserves a small donation
  315. or gift.
  316. I decided not to `cripple' the software by any means.  The Shareware market
  317. seems to get flooded rapidely with such limited programs.  If I should get
  318. to notice that you enjoy my creation without even bothering to express your
  319. pleasure by sending a small amount of money, or by showing any other sign
  320. of acknowledgment, I could also see the need to release future versions or
  321. future software as Shareware, with some options disabled or crippled.
  322. Please consider the consequences this would have.
  323. Thank you.
  324. @endnode
  325. @node Support "JFIF DataType Documentation - Support"
  326. Support
  327. *******
  328. No software is perfect.  If there are any new versions available, perhaps
  329. because there is a bug fixed or a feature was added, I will announce it in
  330. the international Usenet newsgroup comp.sys.amiga.announce, and will upload
  331. it to the Aminet ftp sites.
  332. I am open to suggestions and comments.  Also, if you have problems with the
  333. datatype, you can contact me to ask for help.  However, you cannot expect
  334. me to do everything.  You get the support for free, and I must keep an eye
  335. on my CS studies, so be patient, if you do not get a reply within a week or
  336. @endnode
  337. @node Author "JFIF DataType Documentation - Author"
  338. Author
  339. ******
  340. To send suggestions, bug reports, comments, gifts, flames, etc., you can
  341. contact me at one of the following addresses:
  342.     Christoph Feck
  343.     TowerSystems
  344.     Balbierstrasse 6
  345.     D-67663 Kaiserslautern
  346.     Germany
  347.     Email: feck@informatik.uni-kl.de
  348.     IRC: Pepo (frequently on #amiga and #amigager)
  349. I will forward any mail regarding the MUI version of the preferences editor
  350. directly to Matthias Scheler.
  351. Thank you for your patience reading this!
  352. 3k// Christoph Feck, TowerSystems - BOOPSI Class Development
  353. \\X/ Amiga - Intuition inside.
  354. @endnode
  355.